Delete Customer

This API is used to permanently delete (deactivate) a customer from the system. Deactivation is done as a soft deletion procedure. A customer cannot be deleted if at least one sub-account or one (regular) subscriber is connected to it. Therefore, all that customer’s sub-accounts must be deleted, and all subscribers must be moved as prerequisites to deleting it. After deletion, the customer cannot be recovered.

NOTE: You cannot delete a customer with a Root UUID; the function is denied.

 

HTTP URL  
DELETE /api/v2/customer/{id}

Eligibility

The Requester is eligible to delete (deactivate) only their own customers.

API Request

This API has no request structure.

API Response

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code.
errorMessage String O Failure message.
content Object O Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable Object O Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element Type M/O/CM Description
requestId UUID M

Request instance ID.

To be used by external systems to query the call (operation) status:

  • In progress

  • Successful

  • Failed.

Pageable data objects

Element Type M/O/CM Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code Message
CUSTOMER_1000 Root customer cannot be deleted
CUSTOMER_1002 Customer does not exist
CUSTOMER_1004 Failed to delete customer
CUSTOMER_1009 Customer has siblings and cannot be deleted
GLOBAL_1001 Service unavailable. Please try again

Examples

Request Body

Copy 
{
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy 
{
  "errorCode": "CUSTOMER_1004",
  "errorMessage": "Failed to delete customer",
  "content": "",
  "pageable": ""
}